StartHistoryReadExReq Object
The StartHistoryReadExReq object is used in:
Properties
| Property | SubType | Read Only | Description | Variant |
|---|---|---|---|---|
|
Count |
Integer |
No |
Sets the number of values in the array. |
|
|
Direction |
Integer |
No |
Sets the direction in which the points should be returned. |
|
|
RollupPeriod |
Integer |
No |
Sets the rollup period of the value entry. Rollup period refers to the quantity of units in a period. For example, to rollup 30 days, the RollupPeriod is 30 and the RollupUnit is "days." |
|
|
RollupType |
Integer |
No |
Sets the rollup type of the value entry. The possible values are listed on the CxRollupType enum table. |
|
|
RollupUnits |
Integer |
No |
Sets the rollup units of the value entry. This refers to time increments, such as seconds, minutes, hours, or days. The possible values are listed on the CxRollupUnits enum table. |
|
|
TagString |
Variant |
No |
Sets the tag string for a history point tag. Tag strings are stored in an indexed array as HistoryTagStringEx objects. ExampleWrite to the fifth tag string: |
|
|
TimeStampEnd |
Date |
No |
Sets the timestamp for the ending history record of a time period for a given point. This field is an array of Date subtypes. The timestamp is set in Local time without milliseconds. |
|
|
TimeStampEndMs |
Date |
No |
Sets the timestamp for the ending history record of a time period for a given point. This field is an array of Date subtypes. The timestamp is set in Local time with milliseconds. |
|
|
TimeStampEndRaw |
Date |
No |
Sets the timestamp for the ending history record of a time period for a given point. This field is an array of Date subtypes. The timestamp is set in UTC time with milliseconds. |
|
|
TimeStampStart |
Date |
No |
Sets the timestamp for the starting history record of a time period for a given point. This field is an array of Date subtypes. The timestamp is set in Local time without milliseconds. |
|
|
TimeStampStartMs |
Date |
No |
Sets the timestamp for the starting history record of a time period for a given point. This field is an array of Date subtypes. The timestamp is set in Local time with milliseconds. |
|
|
TimeStampStartRaw |
Date |
No |
Sets the timestamp for the starting history record of a time period for a given point. This field is an array of Date subtypes. The timestamp is set in UTC time with milliseconds. |
|
|
TopOfDayHour |
Integer |
No |
Sets the offset value to use if the subunit to the major unit (i.e. hours to a day) does not start at the time unit expected. For example, to accommodate contract days starting at 5 AM, the TopOfDayHour would be 5 (indicating 5 hours from midnight). |
|
